Allow keyboard shortcuts to work on native devices #17708

azimgd · 2023-04-20T10:42:58Z

Details

Fixed Issues

$ #6883
PROPOSAL: #6883

Tests

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps.

QA Steps

Note: you need to connect hardware keyboard to test mobile keyboard shortcuts on iOS and Android.

Press CMD + K to open "search" sidebar
Press CMD + SHIFT + K to open "newGroup" sidebar
Press CMD + J to open "shortcut" dialog
Press ESC to close any sidebar or dialog
Press ENTER to submit attachment dialog

App/src/CONST.js

Lines 231 to 282 in ef6937c

    
           KEYBOARD_SHORTCUTS: { 
        
               SEARCH: { 
        
                   descriptionKey: 'search', 
        
                   shortcutKey: 'K', 
        
                   modifiers: ['CTRL'], 
        
               }, 
        
               NEW_GROUP: { 
        
                   descriptionKey: 'newGroup', 
        
                   shortcutKey: 'K', 
        
                   modifiers: ['CTRL', 'SHIFT'], 
        
               }, 
        
               SHORTCUT_MODAL: { 
        
                   descriptionKey: 'openShortcutDialog', 
        
                   shortcutKey: 'I', 
        
                   modifiers: ['CTRL'], 
        
               }, 
        
               ESCAPE: { 
        
                   descriptionKey: 'escape', 
        
                   shortcutKey: 'Escape', 
        
                   modifiers: [], 
        
               }, 
        
               ENTER: { 
        
                   descriptionKey: null, 
        
                   shortcutKey: 'Enter', 
        
                   modifiers: [], 
        
               }, 
        
               CTRL_ENTER: { 
        
                   descriptionKey: null, 
        
                   shortcutKey: 'Enter', 
        
                   modifiers: ['CTRL'], 
        
               }, 
        
               COPY: { 
        
                   descriptionKey: 'copy', 
        
                   shortcutKey: 'C', 
        
                   modifiers: ['CTRL'], 
        
               }, 
        
               ARROW_UP: { 
        
                   descriptionKey: null, 
        
                   shortcutKey: 'ArrowUp', 
        
                   modifiers: [], 
        
               }, 
        
               ARROW_DOWN: { 
        
                   descriptionKey: null, 
        
                   shortcutKey: 'ArrowDown', 
        
                   modifiers: [], 
        
               }, 
        
               TAB: { 
        
                   descriptionKey: null, 
        
                   shortcutKey: 'Tab', 
        
                   modifiers: [], 
        
               }, 
        
           },

All of the shortcuts here should work on Web.

List of known issues on Android and iOS: #14767 (comment) which are not counted as regressions.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

KEY_WEB.mov

Mobile Web - Chrome

android.mov

Mobile Web - Safari

Simulator.Screen.Recording.-.iPhone.13.-.2023-03-29.at.07.59.54.mp4

Desktop

key_desktop.mov

iOS

Simulator.Screen.Recording.-.iPhone.13.-.2023-03-29.at.07.55.18.mp4

Android

IMG_2466.MOV

…ycommand

MelvinBot · 2023-04-20T10:43:06Z

@luacmartins @parasharrajat One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

…keycommand-v3

azimgd · 2023-04-20T13:36:22Z

@parasharrajat @luacmartins this is a 1 to 1 copy of #14767 except:

Added: ios/NewExpensify/AppDelegate.mm
Changed: package.json

Hopefully we can test and merge this today.

luacmartins · 2023-04-20T15:13:53Z

Triggered a test build. Links should be ready in ~1h

parasharrajat · 2023-04-20T16:29:15Z

Gonna run the test asap. Currently working on something...might take some time.

parasharrajat · 2023-04-20T20:14:01Z

Tested web and Android. Waiting for iOS which I will do tomorrow after I wake up and then we can merge this.

luacmartins · 2023-04-21T13:25:40Z

nice! thanks for testing this @parasharrajat!

parasharrajat · 2023-04-21T14:07:49Z

BUG: iOS: CMD+I does not open the shortcut modal.

Other than this same as previous PR.

azimgd · 2023-04-21T14:37:47Z

@parasharrajat simulator or the build above?

azimgd · 2023-04-21T15:31:05Z

@luacmartins I'm out of ideas.

Prior to iOS 9, UIKeyCommands could be created and used for the hot-key combinations CMD-B, CMD-I, CMD-U (typically used for bold and italic text) for use in UITextViews and other UITextInput controls.

Starting with iOS 9, UIKeyCommands can still be assigned to these key combinations, but will be ignored by iOS.

https://openradar.appspot.com/25463955

parasharrajat · 2023-04-21T15:57:09Z

simulator or the build above?

Tested on the real device.

parasharrajat · 2023-04-21T16:00:13Z

We can change the shortcut. What if in the future we decide to use this shortcut for something else? May be italicized text in the composer...

azimgd · 2023-04-21T18:45:13Z

@luacmartins Could you trigger a build please?

luacmartins · 2023-04-21T18:59:58Z

done

OSBotify · 2023-04-21T19:52:53Z

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/17708/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/17708/index.html

desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/17708/NewExpensify.dmg	https://17708.pr-testing.expensify.com

luacmartins · 2023-04-24T08:59:14Z

@parasharrajat how's testing going for this one?

parasharrajat · 2023-04-24T09:00:07Z

Haven't checked the latest build. Shall do that now.

parasharrajat · 2023-04-24T10:58:39Z

Bugs:

ESC key does not work on Safari iOS.
On the new Group page, clicking enter on any rows opens a chat from LHN.

Gonna approve this as we are solving this in another issue.

parasharrajat

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

cc: @luacmartins

🎀 👀 🎀 C+ reviewed

luacmartins · 2023-04-24T13:35:29Z

@azimgd there's a conflict

azimgd · 2023-04-24T14:14:50Z

@luacmartins updated.

OSBotify · 2023-04-24T14:49:28Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-04-25T06:08:56Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.5-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-04-26T05:50:56Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.5-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

0xmiros · 2023-07-10T16:53:08Z

src/CONST.js

        },
        SHORTCUT_MODAL: {
            descriptionKey: 'openShortcutDialog',
-            shortcutKey: 'I',
+            shortcutKey: 'J',


Coming from [HOLD for payment 2023-07-10] [$1000] Desktop - Two keyboard shortcuts to open keyboard shortcuts modal #21610:
While changing this shortcut key, we missed deprecating Cmd+I in desktop app menu and shortcut.

0xmiros · 2023-07-12T06:19:26Z

src/styles/styles.js

-        flex: '0 0 auto',
+        flexShrink: 0,
+        flexGrow: 0,
+        flexBasis: 'auto',


Coming from [HOLD for payment 2023-07-12] [$1000] The Keyboard shortcuts modal does not render correctly when the window is resized. #21643:

While this update fixes native issue, it caused regression of web when resize.
More details about the root cause: #21643 (comment).
We should avoid using shorthand property and standard property together in web.

We ignored that issue in the PR. It was decided to tackle such issues in followup PRs.

azimgd added 9 commits April 20, 2023 14:55

install react-native-keycommand

7bf4323

android library setup

7dc9c6b

ios library setup

16a939d

add jest mocks for keycommand

8072f57

add shortcuts constants

521f622

move button component to support shortcut validation

bb17f08

add native shortcut support to keyboardshortcutsmodal

36f843b

refactor keyboardshortcut library and add support for react-native-ke…

cbf030c

…ycommand

remove platform specific code from about page

9e0932c

azimgd requested a review from a team as a code owner April 20, 2023 10:42

melvin-bot bot requested review from luacmartins and parasharrajat and removed request for a team April 20, 2023 10:43

azimgd added 2 commits April 20, 2023 15:55

fixing linting errors

921f619

Merge branch 'keycommand-v3' of github.com:azimgd/expensify-app into …

54c94df

…keycommand-v3

azimgd force-pushed the keycommand-v3 branch from 75f5628 to 54c94df Compare April 20, 2023 11:10

Merge branch 'main' into keycommand-v3

f3abf8f

luacmartins added the Ready To Build label Apr 20, 2023

luacmartins approved these changes Apr 20, 2023

View reviewed changes

luacmartins previously approved these changes Apr 21, 2023

View reviewed changes

change CMD+I to CMD+J which was ignored by iOS

abb95b0

azimgd dismissed luacmartins’s stale review via abb95b0 April 21, 2023 18:27

Merge branch 'Expensify:main' into keycommand-v3

e95132b

parasharrajat previously approved these changes Apr 24, 2023

View reviewed changes

merge main

0370147

azimgd dismissed parasharrajat’s stale review via 0370147 April 24, 2023 13:55

revert automatic changes to project.pbxproj

e63cf1a

luacmartins approved these changes Apr 24, 2023

View reviewed changes

luacmartins merged commit d9047e0 into Expensify:main Apr 24, 2023

OSBotify mentioned this pull request Apr 25, 2023

Deploy Checklist: New Expensify 2023-04-25 #17948

Closed

37 tasks

MelvinBot mentioned this pull request Apr 26, 2023

[HOLD for payment 2023-05-03] [HOLD for payment 2023-04-26] [$32,000] Allow keyboard shortcuts to work on native devices #6883

Closed

0xmiros reviewed Jul 10, 2023

View reviewed changes

0xmiros mentioned this pull request Jul 10, 2023

[HOLD for payment 2023-07-10] [$1000] Desktop - Two keyboard shortcuts to open keyboard shortcuts modal #21610

Closed

6 tasks

0xmiros reviewed Jul 12, 2023

View reviewed changes

0xmiros mentioned this pull request Jul 12, 2023

[HOLD for payment 2023-07-12] [$1000] The Keyboard shortcuts modal does not render correctly when the window is resized. #21643

Closed

6 tasks

mollfpr mentioned this pull request Jul 31, 2023

[HOLD for payment 2023-10-23] [HOLD for payment 2023-10-23] [HOLD for payment 2023-10-20] [HOLD for payment 2023-10-20] [$1000] IOU - Selecting currency in BNP and pressing "CMD+ENTER" results in accidental redirection #23395

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow keyboard shortcuts to work on native devices #17708

Allow keyboard shortcuts to work on native devices #17708

azimgd commented Apr 20, 2023 •

edited

Loading

MelvinBot commented Apr 20, 2023

azimgd commented Apr 20, 2023

luacmartins commented Apr 20, 2023

parasharrajat commented Apr 20, 2023

parasharrajat commented Apr 20, 2023

luacmartins commented Apr 21, 2023

parasharrajat commented Apr 21, 2023 •

edited

Loading

azimgd commented Apr 21, 2023

azimgd commented Apr 21, 2023

parasharrajat commented Apr 21, 2023

parasharrajat commented Apr 21, 2023 •

edited

Loading

azimgd commented Apr 21, 2023

luacmartins commented Apr 21, 2023

OSBotify commented Apr 21, 2023

luacmartins commented Apr 24, 2023

parasharrajat commented Apr 24, 2023 •

edited

Loading

parasharrajat commented Apr 24, 2023 •

edited

Loading

parasharrajat left a comment

luacmartins commented Apr 24, 2023

azimgd commented Apr 24, 2023

OSBotify commented Apr 24, 2023

OSBotify commented Apr 25, 2023

OSBotify commented Apr 26, 2023

0xmiros Jul 10, 2023

0xmiros Jul 12, 2023

parasharrajat Jul 12, 2023

	KEYBOARD_SHORTCUTS: {
	SEARCH: {
	descriptionKey: 'search',
	shortcutKey: 'K',
	modifiers: ['CTRL'],
	},
	NEW_GROUP: {
	descriptionKey: 'newGroup',
	shortcutKey: 'K',
	modifiers: ['CTRL', 'SHIFT'],
	},
	SHORTCUT_MODAL: {
	descriptionKey: 'openShortcutDialog',
	shortcutKey: 'I',
	modifiers: ['CTRL'],
	},
	ESCAPE: {
	descriptionKey: 'escape',
	shortcutKey: 'Escape',
	modifiers: [],
	},
	ENTER: {
	descriptionKey: null,
	shortcutKey: 'Enter',
	modifiers: [],
	},
	CTRL_ENTER: {
	descriptionKey: null,
	shortcutKey: 'Enter',
	modifiers: ['CTRL'],
	},
	COPY: {
	descriptionKey: 'copy',
	shortcutKey: 'C',
	modifiers: ['CTRL'],
	},
	ARROW_UP: {
	descriptionKey: null,
	shortcutKey: 'ArrowUp',
	modifiers: [],
	},
	ARROW_DOWN: {
	descriptionKey: null,
	shortcutKey: 'ArrowDown',
	modifiers: [],
	},
	TAB: {
	descriptionKey: null,
	shortcutKey: 'Tab',
	modifiers: [],
	},
	},

Allow keyboard shortcuts to work on native devices #17708

Allow keyboard shortcuts to work on native devices #17708

Conversation

azimgd commented Apr 20, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 20, 2023

azimgd commented Apr 20, 2023

luacmartins commented Apr 20, 2023

parasharrajat commented Apr 20, 2023

parasharrajat commented Apr 20, 2023

luacmartins commented Apr 21, 2023

parasharrajat commented Apr 21, 2023 • edited Loading

azimgd commented Apr 21, 2023

azimgd commented Apr 21, 2023

parasharrajat commented Apr 21, 2023

parasharrajat commented Apr 21, 2023 • edited Loading

azimgd commented Apr 21, 2023

luacmartins commented Apr 21, 2023

OSBotify commented Apr 21, 2023

luacmartins commented Apr 24, 2023

parasharrajat commented Apr 24, 2023 • edited Loading

parasharrajat commented Apr 24, 2023 • edited Loading

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

luacmartins commented Apr 24, 2023

azimgd commented Apr 24, 2023

OSBotify commented Apr 24, 2023

OSBotify commented Apr 25, 2023

OSBotify commented Apr 26, 2023

0xmiros Jul 10, 2023

Choose a reason for hiding this comment

0xmiros Jul 12, 2023

Choose a reason for hiding this comment

parasharrajat Jul 12, 2023

Choose a reason for hiding this comment

azimgd commented Apr 20, 2023 •

edited

Loading

parasharrajat commented Apr 21, 2023 •

edited

Loading

parasharrajat commented Apr 21, 2023 •

edited

Loading

parasharrajat commented Apr 24, 2023 •

edited

Loading

parasharrajat commented Apr 24, 2023 •

edited

Loading